Inside Macintosh: QuickDraw GX Objects /

Chapter 8 - Tag Objects / Tag Objects Reference

Functions / Directly Manipulating the Data in a Tag Object

GXUnlockTag

You can use the GXUnlockTag function to allow QuickDraw GX to relocate, flatten, or unload a tag object.

void GXUnlockTag(gxTag target);

target

A reference to the tag object to unlock.

DESCRIPTION

The GXUnlockTag function frees a previously locked tag object for relocation.
To directly edit a tag's contents, you must first call GXLockTag. You can then
call GXGetTagStructure and edit the tag's contents. After editing, you must call GXUnlockTag.

You cannot dispose of a tag that is locked. You must first call GXUnlockTag on a locked tag object before calling GXDisposeTag.

SPECIAL CONSIDERATIONS

To avoid fragmenting the QuickDraw GX heap, you should call the GXUnlockTag function as soon as possible after calling GXLockTag.

You can nest calls to these direct-access routines, but be sure to call GXUnlockTag as many times as you call GXLockTag.

RESULT CODE

Errors
tag_is_nil
Notices (debugging version)
tag_not_locked

SEE ALSO

The GXLockTag function is described in the previous section. The GXGetTagStructure function is described in the next section.

The GXDisposeTag function is described on page 8-14.